home *** CD-ROM | disk | FTP | other *** search
/ Acorn RISC PD-CD 1 / Acorn RISC PD-CD 1.iso / languages / c / updatec < prev   
Encoding:
Text File  |  1993-03-07  |  17.4 KB  |  573 lines

  1. This is simply an enhancement to Acorn's DDE C help file to make it more
  2. user friendly. It annoyed me just slightly that most of the help I needed
  3. was in the file, but that you needed to type the EXACT word to find it. No
  4. use since I can never remember these things, and there were no Indexes. 
  5.  
  6. All this has now been solved. Delete the text up to and including the 
  7. "DELETE UP TO HERE" marker and then add it on to the file called 
  8. "DDE.!SrcEdit.help.C" 
  9.  
  10. Hope you find this useful. To contact me ask for help on topics.
  11.  
  12.  
  13.  
  14. DELETE UP TO HERE
  15.  
  16. %version
  17. This is help file version 1.02
  18.  
  19. Improvements :
  20. Version 1.00  Original Acorn help file
  21. Version 1.01  Added help on the libraries
  22. Version 1.02  Added help on C commands as well as an index
  23.  
  24. %help
  25. Try help on 'topics', 'commands', 'libraries' , 'general' or 'index'.
  26.  
  27. %topics
  28. Help topics available are :
  29.   
  30. commands  - a list of C commands
  31. libraries - name of libraries available
  32. general   - lists of further help topics grouped by general area
  33. index     - an index of all help topics available
  34.  
  35. This extension to the help file was provided by Justin Williams (28/06/92)
  36.  
  37. To contact me write to :
  38. PO Box 1051
  39. Wandsbeck
  40. 3631
  41. South Africa
  42.  
  43. E-Mail : williamj@shrike.und.ac.za
  44.  
  45. Future updates will be made available. 
  46.  
  47. %statements
  48. See commands
  49.  
  50. %keywords
  51. See commands
  52.  
  53. %commands
  54. The list of C commands follows : 
  55.   
  56. block 
  57. break
  58. case
  59. continue
  60. do
  61. else
  62. for
  63. goto 
  64. if
  65. label 
  66. null
  67. return
  68. switch
  69. while
  70.  
  71. For futher help ask for help on a particular command. 
  72. %block
  73. Block statements are defined using the curly brackets {}
  74.  
  75. Eg. { printf("Hello"); printf("Goodbye"); }
  76.  
  77. would be treated as one statement
  78.  
  79. %break
  80. The statement 
  81.  
  82.  break;
  83.  
  84. causes termination of the smallest enclosing while, do, for or
  85. switch statement. Control passes to the statement following the
  86. terminated statement.
  87.  
  88. %continue
  89. The statement continue; passes control to the loop-continuation 
  90. portion of the smallest enclosing while, do, or for statement i.e.
  91. to the end of the loop. 
  92.  
  93. Eg.   while (...) {       do {              for (....) {
  94.        ...                 ...               ...
  95.        contin: ;           contin: ;         contin: ;
  96.       }                   } while (...);     }
  97.  
  98. In each case, a continue statement would be the equivalent of a 
  99. goto contin statement. 
  100.  
  101. %case
  102. See 'switch'.
  103.  
  104. %do
  105. This statement has the form :
  106.  
  107.  do statement while (expression)
  108.  
  109. The substatement is executed repeatedly until the value of the
  110. expression becomes zero. The test takes place after the execution 
  111. of the statement. 
  112.  
  113. %else
  114. See 'if'.
  115.              
  116. %goto
  117. Control may be transferred unconditionally by means of the statement
  118.  
  119.  goto identifier;
  120.   
  121. The identifier must be a label located in the current function.
  122.  
  123. %if
  124. The two forms of the conditional statement are :
  125.  
  126. if (expression) statement 
  127. if (expression) statement else statement
  128.  
  129. The expression is evaluated and if it is non-zero, the first sub-
  130. statement is executed. The else is executed if it is zero. If there
  131. is an ambigouous else statement, it is connected with the last 
  132. else-less statement. 
  133.       
  134. %label
  135. Any statement may be preceded by label prefixes of the form
  136.  
  137.  identifier :
  138.  
  139. which serves to declare the identifier as a label. The only use of
  140. a label is as the target of a goto. The scope of the label is the
  141. current function, excluding any sub-blocks in which it has been
  142. re-defined.
  143.     
  144. %null
  145. The null statement has the form
  146.  
  147.   ;
  148.  
  149. A null statement is useful to carry a label just before the } of
  150. a compound statement or to supply a null body to a loop such as 
  151. while.
  152.  
  153. %return
  154. A function returns to its caller by means of the return statement
  155. which has one of the following forms
  156.  
  157.   return ;
  158.   return expression ;
  159.  
  160. In the first case the returned value is undefined. In the second
  161. case the value of the expression is returned. If required, the
  162. value is converted, as if by assignment, to the type of the
  163. function in which it appears. Flowing off the end of the function
  164. is the same as returning no value.
  165.  
  166. %switch
  167. The switch statement causes control to be transferred to one of
  168. several statement depending on the value of an expression. It has
  169. the form :
  170.  
  171.   switch (expression) statement
  172.  
  173. The usual conversion is done on the expression, but the result must
  174. be of type int. The statement is typically compound. Any statement
  175. within the compound statement must be labelled with one or more
  176. case prefixes as follows :
  177.  
  178.   case constant-expression :
  179.  
  180. where the constant expression must be int. No two cases must be the
  181. same. 
  182.  
  183. There may also be at most one statement prefix of the form
  184.  
  185.   default : 
  186.  
  187. When the switch statement is executed its expression is evaluated
  188. and compared with each case consant. If one of the cases matches, 
  189. control is passed to the statement following the matched case
  190. prefix. If there are no matches, control is passed to the default
  191. prefix. If there is no default, none of the statements will be
  192. executed.  
  193.  
  194. Each case must be ended with a break statement. 
  195.  
  196. Example :
  197.  
  198.  Switch choice {
  199.    case 'A' : printf("A selected"); break; 
  200.    case 'B' : printf("B selected"); break;
  201.    default  : printf("no valid selection"); break;
  202.   }
  203.  
  204. %while
  205. The while statement has the form
  206.  
  207.   while (expression) statement
  208.  
  209. The substatement is executed repeatedly as long as the expression
  210. remains non-zero. The test takes place before the execution of
  211. the statement. 
  212.  
  213. %libraries
  214. Libraries available are :
  215.     
  216. * assert.h     - define assert debugging macro
  217. * ctype.h      - contains info used by character classification and
  218.                   conversion macros such as isalpha. 
  219.   errno.h      - defines constant mnemonics for the error codes
  220.   float.h      - contains parameters for floating point routines
  221.   kernel.h     - interface to host operating system
  222.   limits.h     - contains environmental parameters & info about limitations
  223. * locale.h     - declares routines and data types to handle country standards
  224. * math.h       - declares prototypes for maths functions
  225. * setjmp.h     - declares type jmp_buf and also routines longjmp and setjmp
  226. * signal.h     - declares ssignal and gsignal
  227. * stdarg.h     - defines macros for reading the argument list in functions
  228. * stddef.h     - defines a number of standard data types and macros 
  229. * stio.h       - defines types, macros and functions needed for standard I/O 
  230. * stdlib.h     - declares several commonly used routines
  231. * string.h     - declares several string and memory manipulation routines
  232.   swis.h       - sets constants defining the RISC OS SWI numbers
  233. * time.h       - defines some time routines and structures                   
  234. * varargs.h    - used for variable parameter lists
  235.      
  236. If you can't find the information you need in the help file, try and have
  237. a look in the header file. More information is given there. 
  238.  
  239. * indicates further help available on that library, leave off the .h 
  240.  
  241. %varargs.h
  242. See 'varargs'
  243.  
  244. %varargs
  245. VarArgs - variable parameter list handling
  246.  
  247. va_dcl          va_start        va_end          va_arg
  248.  
  249. Ask for help on the function for further information.
  250.  
  251. %stddef.h
  252. See 'stddef'
  253.  
  254. %stddef
  255. StdDef - Standard Defintions
  256.  
  257. offsetof
  258.  
  259. Type defintions :
  260.  
  261. ptrdiff_t       size_t          wchar_t
  262.  
  263. Ask for help on the function or type for further information. 
  264.   
  265. %stdarg.h
  266. See 'stdarg'
  267.  
  268. %stdarg
  269. StdArg - Standard Arguments
  270.  
  271. va_start        va_arg          va_end
  272.  
  273. Ask for help on the function for further information.
  274.  
  275. %signal.h
  276. Signal - Functions for handling conditions that may be encountered during
  277.           execution of a program
  278.  
  279. signal          raise
  280.  
  281. Associated variables :
  282.  
  283. SIG_DFL         SIG_ERR         SIG_IGN         SIGABRT
  284. SIGFPE          SIGILL          SIGINT          SIGSEGV
  285. SIGTERM         SIGSTAK         SIGUSR1         SIGUSR2
  286. SIGOSERROR
  287.  
  288. Ask for help on the function or variable for further information.
  289.  
  290. %setjmp.h
  291. SetJmp - Functions for dealing with abnormal calling of low level routines
  292.  
  293. setjmp          longjmp
  294.  
  295. Ask for help on the function for further information.
  296.  
  297. %locale.h
  298. See 'locale'
  299.  
  300. %locale
  301. Locale - Handles national characteristics
  302.  
  303. setlocale       localeconv
  304.  
  305. Ask for help on the function for further information.
  306.  
  307. %asset.h
  308. See 'assert'
  309.  
  310. %stdio.h
  311. See 'stdio'
  312.  
  313. %stdio
  314. StdIO - Standard IO routines
  315.  
  316. clearerr        fclose          feof            ferror
  317. fflush          fgetc           fgetpos         fgets
  318. fopen           fprintf         fputc           fputs
  319. fread           freopen         fscanf          fseek
  320. fsetpos         ftell           fwrite          getc
  321. getchar         gets            perror          printf
  322. putc            putchar         remove          rename
  323. rewind          scanf           setbuf          setvbuf
  324. sprintf         sscanf          tmpfile         tmpnam
  325. ungetc          vfprintf        vprintf         vsprintf
  326.  
  327. Ask for help on the function for further information.
  328.  
  329. %time.h
  330. See 'time'
  331.  
  332. %time
  333. Time - Time manipulating functions
  334.  
  335. clock           difftime        mktime          time
  336. asctime         ctime           gmtime          localtime
  337. strftime
  338.  
  339. Ask for help on the function for further information.
  340.  
  341. %stdlib.h
  342. See 'stdlib'
  343.  
  344. %stdlib
  345. Stdlib - Standard library functions
  346.  
  347. abort           abs             atexit          atof            
  348. atoi            atol            bsearch         calloc          
  349. div             exit            free            getenv          
  350. labs            ldiv            malloc          mblen           
  351. mbstowcs        mbtowc          qsort           rand            
  352. realloc         srand           strtod          strtol          
  353. strtoul         system          wcstombs        wctomb
  354. _ANSI_rand      _ANSI_srand     
  355.  
  356.  
  357. Ask for help on the function for further information.
  358.  
  359.  
  360. %math.h
  361. See 'math'
  362.  
  363. %math
  364. Math - Maths functions
  365.  
  366. atof            ceil            exp             fabs
  367. floor           fmod            frexp           ldexp
  368. log             log10           modf            pow
  369. sqrt
  370.  
  371. Ask for help on the function for further information.
  372.  
  373. See 'trig' for the trig functions defined in Math.h
  374.  
  375. %ctype.h
  376. See 'ctype'
  377.  
  378. %ctype
  379. Ctype - Classification and conversion routines
  380.  
  381. Classification routines :
  382. isalnum  - returns true if arg is alphabetic or numeric
  383. isalpha  - returns true if arg is alphabetic
  384. iscntrl  - returns true if arg is a control character
  385. isdigit  - returns true if arg is a decimal digit
  386. isgraph  - returns true if arg is a printable character other than space
  387. islower  - returns true if arg is a lower-case letter
  388. isprint  - returns true if arg is a printable character
  389. ispunct  - returns true if arg is a printable but not space or alpha-numeric
  390. isspace  - returns true if arg is a white-space character
  391. isupper  - returns true if arg is an upper-case letter
  392. isxdigit - returns true if arg is a hex digit (0-F)
  393.  
  394. Conversion routines :
  395. tolower  - returns the lower-case equivalent of arg
  396. toupper  - returns the upper-case equivalent of arg
  397.  
  398. %general
  399. Further help is available on :
  400.  
  401. memory
  402. operators
  403. string
  404. trig 
  405.          
  406. %operators 
  407. Unary and Binary operators
  408.  
  409.  * multiplication
  410.  / division
  411.  % modulus
  412.  + addition
  413.  - subtraction
  414.  
  415. Increment and Decrement operators
  416.  
  417. ++ increment         Usage : ++b increments b before using it
  418. -- decrement                 b++ increments b after using it
  419.  
  420. Bitwise operators
  421.  
  422. << shift left         |  or
  423. >> shift right        ^  exclusive or  
  424. &  and                ~  not
  425.  
  426. Relational operators
  427.  
  428. >  greater than             >= greater than or equal to
  429. <  less than                <= less than or equal to
  430. == equal to                 != not equal to
  431.  
  432. Logical operators
  433.  
  434. && and     || or      !  not
  435.  
  436. %trig
  437. Trig - Trigonometric functions
  438.  
  439. Defined in : math.h
  440.  
  441. acos            asin            atan            atan2
  442. cos             cosh            sin             sinh
  443. tan             tanh
  444.         
  445. %string
  446. String - String functions
  447.   
  448. Defined in : string.h
  449.   
  450. strcat  - adds copy of source to end of destination
  451. strchr  - scans a string for the 1st occurence of a given string
  452. strcmp  - compares one string to another
  453. strcpy  - copies one string into another
  454. strcspn - scans a string for the 1st segment not containing any subset of
  455.            a given set if characters
  456. strlen  - calculates the length of a string
  457. strncat - adds n (or less) characters from source to end of destination
  458. strncmp - compares a portion of one string to a portion of another
  459. strncpy - copies a number of bytes from one string into another, truncating 
  460.            or padding as necessary
  461. strpbrk - scans a string for the 1st occurrence of any character from a
  462.            given set
  463. strspn  - scans a string for the 1st segment that is a subset of a given set 
  464.            of characters
  465. strstr  - scans a string for the occurence of a given sub-string
  466. strtod  - converts a string to a double value
  467. strtok  - searches one string for tokens, which are separated by delimiters
  468.            which are defined in another
  469. strtol  - converts a string into a long value
  470.   
  471. Related : See 'memory' for other functions defined in string.h
  472.  
  473. %memory
  474. Memory - memory related functions
  475.   
  476. Defined in : String.h
  477.   
  478. memcpy   - copies a block of n bytes from source to destination
  479. memmove  - as above, but works for overlapping memory areas
  480. memset   - sets all the bytes of an area to a specific character
  481. memcmp   - compares two strings, for a length of exactly n characters
  482. memchr   - searches the first n bytes of array s for character ch
  483.   
  484. Related : See 'string' for other functions defined in string.h
  485.  
  486. %string.h
  487. See 'string' for string functions
  488. See 'memory' for memory functions
  489.  
  490. %Index
  491. Try 'index'
  492. %INDEX
  493. Try 'index'              
  494. %index
  495. C Index : Help is available on the following topics :
  496.                (Note : Case is essential)
  497.  
  498. abort           abs             acos            asctime
  499. asin            assert          asset.h         atan
  500. atan2           atexit          atof            atoi
  501. atol            block           break           bsearch
  502. BUFSIZ          calloc          case            ceil
  503. CHAR_BIT        CHAR_MAX        CHAR_MIN        clearerr
  504. clock           CLOCKS_PER_SEC  clock_t         commands
  505. continue        cos             cosh            ctime
  506. ctype           ctype.h         DBL_DIG         DBL_EPSILON
  507. DBL_MANT_DIG    DBL_MAX         DBL_MAX_10_EXP  DBL_MAX_EXP
  508. DBL_MIN         DBL_MIN_10_EXP  DBL_MIN_EXP     difftime
  509. div             div_t           do              EDOM
  510. else            EOF             ERANGE          errno
  511. ESIGNUM         exit            EXIT_FAILURE    EXIT_SUCCESS
  512. exp             fabs            fclose          feof
  513. ferror          fflush          fgetc           fgetpos
  514. fgets           FILE            FILENAME_MAX    floor
  515. FLT_DIG         FLT_EPSILON     FLT_MANT_DIG    FLT_MAX
  516. FLT_MAX_10_EXP  FLT_MAX_EXP     FLT_MIN         FLT_MIN_10_EXP
  517. FLT_MIN_EXP     FLT_RADIX       FLT_ROUNDS      fmod
  518. fname           fopen           fpos_t          fprintf
  519. fputc           fputs           fread           free
  520. freopen         frexp           fscanf          fseek
  521. fsetpos         ftell           fwrite          general
  522. getc            getchar         getenv          gets
  523. gmtime          goto            help            HUGE_VAL
  524. if              index           INT_MAX         INT_MIN
  525. isalnum         isalpha         iscntrl         isdigit
  526. isgraph         islower         isprint         isprint
  527. ispunct         isspace         isupper         isxdigit
  528. keywords        label           labs            LC_ALL
  529. LC_COLLATE      LC_CTYPE        LC_MONETARY     LC_NUMERIC
  530. LC_TIME         LDBL_DIG        LDBL_EPSILON    LDBL_MANT_DIG
  531. LDBL_MAX        LDBL_MAX_10_EXP LDBL_MAX_EXP    LDBL_MIN
  532. LDBL_MIN_10_EXP LDBL_MIN_EXP    ldexp           ldiv
  533. ldiv_t          libraries       locale          locale.h
  534. localeconv      localtime       log             log10
  535. longjmp         LONG_MAX        LONG_MIN        L_tmpnam
  536. malloc          math            math.h          mblen
  537. mbstowcs        mbtowc          MB_CUR_MAX      MB_LEN_MAX
  538. memchr          memcmp          memcpy          memmove
  539. memory          memset          mktime          modf
  540. null            offsetof        operators       perror
  541. pow             printf          ptrdiff_t       putc
  542. putchar         puts            qsort           raise
  543. rand            RAND_MAX        realloc         remove
  544. rename          return          scanf           SCHAR_MAX
  545. SCHAR_MIN       setbuf          setjmp          setjmp.h
  546. setlocale       setvbuf         SHRT_MAX        SHRT_MIN
  547. SIGABRT         SIGFPE          SIGILL          SIGINT
  548. signal          signal.h        SIGOSERROR      SIGSEGV
  549. SIGSTAK         SIGTERM         SIGUSR1         SIGUSR2
  550. SIG_DFL         SIG_ERR         SIG_IGN         sin
  551. sinh            size_t          sprintf         sqrt
  552. srand           sscanf          statements      stdarg
  553. stdarg.h        stddef          stddef.h        stderr
  554. stdin           stdio           stdio.h         stdlib
  555. stdlib.h        stdout          strcat          strchr
  556. strcmp          strcoll         strcpy          strcspn
  557. strerror        strftime        string          string.h
  558. strlen          strncat         strncmp         strncpy
  559. strpbrk         strrchr         strspn          strstr
  560. strtod          strtok          strtol          strtoul
  561. strxfrm         switch          system          tan
  562. tanh            time            time            time.h
  563. time_t          tmpfile         tmpnam          TMP_MAX
  564. tolower         topics          toupper         trig
  565. UCHAR_MAX       UINT_MAX        ULONG_MAX       ungetc
  566. USHRT_MAX       varargs         varargs.h       va_arg
  567. va_end          va_start        version         vfprintf
  568. vprintf         vsprintf        wchar_t         wcstombs
  569. wctomb          while           _ANSI_rand      _ANSI_RAND_MAX
  570. _ANSI_srand
  571.  
  572. The extensions to this help file were provided by Justin Williams (28/06/92)
  573.